home *** CD-ROM | disk | FTP | other *** search
/ Windows Expert / Windows Expert.iso / utility / wxlslib.zip / xlslib / xlisp.hlp < prev   
Text File  |  1992-02-20  |  36KB  |  535 lines

  1. (*OBJECT* OBJECT PROTO)
  2. "The root object."
  3. (WINDOW-PROTO  OBJECT PROTO)
  4. "Window prototype."
  5. (GRAPH-WINDOW-PROTO  OBJECT PROTO)
  6. "Basic graphics window prototype."
  7. (GRAPH-PROTO  OBJECT PROTO)
  8. "Basic graphics window prototype."
  9. (SPIN-PROTO  OBJECT PROTO)
  10. "Rotating plot"
  11. (SCATMAT-PROTO  OBJECT PROTO)
  12. "Scatterplot matrix"
  13. (NAME-LIST-PROTO  OBJECT PROTO)
  14. "Name list"
  15. (HISTOGRAM-PROTO  OBJECT PROTO)
  16. "Histogram"
  17. (SCATTERPLOT-PROTO  OBJECT Proto)
  18. "Scatterplot"
  19. +
  20. "Args: (&rest numbers)\nReturns the sum of its arguments.  With no args, returns 0. Vectorized."
  21. -
  22. "Args: (number &rest more-numbers)\nSubtracts the second and all subsequent NUMBERs from the first. With one arg,\nnegates it. Vectorized."
  23. *
  24. "Args: (&rest numbers)\nReturns the product of its arguments. With no args, returns 1. Vectorized."
  25. /
  26. "Args: (number &rest more-numbers)\nDivides the first NUMBER (element-wise) by each of the subsequent NUMBERS.\nWith one arg, returns its reciprocal. Vectorized."
  27. ^
  28. "Args: (base-number power-number)\nReturns BASE-NUMBER raised to the power POWER-NUMBER. Vectorized."
  29. **
  30. "Args: (base-number power-number)\nReturns BASE-NUMBER raised to the power POWER-NUMBER. Vectorized."
  31. <
  32. "Args: (&rest numbers)\nReturns T if NUMBERS are in strictly increasing order; NIL otherwise.\nVectorized."
  33. <=
  34. "Args: (&rest numbers)\nReturns T if NUMBERS are in nondecreasing order; NIL otherwise. Vectorized."
  35. =
  36. "Args: (&rest numbers)\nReturns T if NUMBERS are all equal; NIL otherwise. Vectorized."
  37. /=
  38. "Args: (&rest numbers)\nReturns T if NUMBERS no two adjacent numbers are equal; NIL otherwise. Vectorized."
  39. >=
  40. "Args: (&rest numbers)\nReturns T if NUMBERS are in nonincreasing order; NIL otherwise. Vectorized."
  41. >
  42. "Args: (&rest numbers)\nReturns T if NUMBERS are in strictly decreasing order; NIL otherwise. Vectorized."
  43. ABS
  44. "Args: (number)\nReturns the absolute value or modulus of NUMBER. Vectorized."
  45. ACOS
  46. "Args: (number)\nReturns the arc cosine of NUMBER. Vectorized."
  47. ASIN
  48. "Args: (number)\nReturns the arc sine of NUMBER. Vectorized."
  49. ATAN
  50. "Args: (number)\nReturns the arc tangent of NUMBER. Vectorized."
  51. CEILING
  52. "Args: (number)\nReturns the smallest integer(s) not less than or NUMBER. Vectorized."
  53. COMPLEX
  54. "Args: (realpart &optional (imagpart 0))\nReturns a complex number with the given real and imaginary parts."
  55. CONJUGATE
  56. "Args: (number)\nReturns the complex conjugate of NUMBER."
  57. COS
  58. "Args: (radians)\nReturns the cosine of RADIANS. Vectorized."
  59. EXP
  60. "Args: (x)\nCalculates e raised to the power x, where e is the base of natural\nlogarithms. Vectorized."
  61. EXPT
  62. "Args: (base-number power-number)\nReturns BASE-NUMBER raised to the power POWER-NUMBER. Vectorized."
  63. FLOAT
  64. "Args: (number)\nConverts real number to a floating-point number.  If NUMBER is\nalready a float, FLOAT simply returns NUMBER. Vectorized."
  65. FLOOR
  66. "Args: (number)\nReturns the largest integer( not larger than the NUMBER. Vectorized."
  67. IMAGPART
  68. "Args: (number)\nExtracts the imaginary part of NUMBER."
  69. LOG
  70. "Args: (number)\nReturns the natural logarithm(s) of NUMBER. Vectorized."
  71. LOG-GAMMA
  72. "Args: (x)\nReturns the log gamma function of X. Vectorized."
  73. MAX
  74. "Args: (number &rest more-numbers)\nReturns the greatest of its arguments. Vector reducing"
  75. MIN
  76. "Args: (number &rest more-numbers)\nReturns the least of its arguments. Vector reducing"
  77. PHASE
  78. "Args: (number)\nReturns the angle part of the polar representation of a complex number.\nFor non-complex numbers, this is 0."
  79. PMAX
  80. "Args: (&rest items)\nParallel maximum of ITEMS. Vectorized."
  81. PMIN
  82. "Args: (&rest items)\nParallel minimum of ITEMS. Vectorized."
  83. PROD
  84. "Args: (&rest number-data)\nReturns the product of all the elements of its arguments. Returns 1 if there\nare no arguments. Vector reducing."
  85. RANDOM
  86. "Args: (number)\nGenerates a uniformly distributed pseudo-random number between zero (inclusive)\nand NUMBER (exclusive). Vectorized."
  87. REALPART
  88. "Args: (number)\nExtracts the real part of NUMBER."
  89. MOD
  90. "Args: (x y)\nReturns x mod y. Vectorized."
  91. REM
  92. "Args: (x y)\nReturns the remainder of dividing x by y. Vectorized."
  93. ROUND
  94. "Args: (number)\nRounds NUMBER to nearest integer. Vectorized."
  95. SIN
  96. "Args: (radians)\nReturns the sine of RADIANS. Vectorized."
  97. SQRT
  98. "Args: (number)\nReturns the square root of NUMBER. Vectorized."
  99. SUM
  100. "Args: (&rest number-data)\nReturns the sum of all the elements of its arguments. Returns 0 if there\nare no arguments. Vector reducing."
  101. TAN
  102. "Args: (radians)\nReturns the tangent of RADIANS. Vectorized."
  103. TRUNCATE
  104. "Args: (number)\nReturns real NUMBER as an integer, rounded toward 0. Vectorized."
  105. DEF
  106. "Syntax: (def var form)\nVAR is not evaluated and must be a symbol.  Assigns the value of FORM to\nVAR and adds VAR to the list *VARIABLES* of def'ed variables. Returns VAR.\nIf VAR is already bound and the global variable *ASK-ON-REDEFINE*\nis not nil then you are asked if you want to redefine the variable."
  107. ISEQ
  108. "Args: (n &optional m)
  109. With one argumant returns a list of consecutive integers from 0 to N - 1.
  110. With two returns a list of consecutive integers from N to M.
  111. Examples: (iseq 4) returns (0 1 2 3)
  112.           (iseq 3 7)  returns (3 4 5 6 7)
  113.           (iseq 3 -3) returns (3 2 1 0 -1 -2 -3)"
  114. LIST
  115. "Args: (&rest args)\nReturns a list of its arguments"
  116. REPEAT
  117. "\nArgs: (vals times)\nRepeats VALS. If TIMES is a number and VALS is a non-null, non-array atom, a list\nof length TIMES with all elements eq to VALS is returned. If VALS is a list and\nTIMES is a number then VALS is appended TIMES times. If TIMES is a list of numbers\nthen VALS must be a list of equal length and the simpler version of repeat is\nmapped down the two lists.\nExamples: (repeat 2 5)                 returns (2 2 2 2 2)\n          (repeat '(1 2) 3)            returns (1 2 1 2 1 2)\n\t  (repeat '(4 5 6) '(1 2 3))   returns (4 5 5 6 6 6)\n\t  (repeat '((4) (5 6)) '(2 3)) returns (4 4 5 6 5 6 5 6)"
  118. SAMPLE
  119. "Args: (x n &optional (replace nil))
  120. Returns a list of a random sample of size N from sequence X drawn with or
  121. without replacement."
  122. SELECT
  123. "\nArgs: (a &rest indices)\nA can be a list or an array. If A is a list and INDICES is a single number\nthen the appropriate element of A is returned. If  is a list and INDICES is\na list of numbers then the sublist of the corresponding elements is returned.\nIf A in an array then the number of INDICES must match the ARRAY-RANK of A.\nIf each index is a number then the appropriate array element is returned.\nOtherwise the INDICES must all be lists of numbers and the corresponding\nsubmatrix of A is returned. SELECT can be used in setf."
  124. UNDEF
  125. "Args: (symbol)\nIf SYMBOL is a defined variable it is unbound and removed from the list of\ndefined variables and returns SYMBOL."
  126. VECTOR
  127. "Args: ({item}*)\nReturns a vector with ITEMs as elements."
  128. WHICH
  129. "Args: (x)\nX is an array or a list. Returns a list of the indices where X is not NIL."
  130. BETA-CDF
  131. "Args: (x alpha beta)\nReturns the value of the Beta(ALPHA, BETA) distribution function at X.\nVectorized."
  132. BETA-DENS
  133. "Args: (x alpha beta)\nReturns the density at X of the Beta(ALPHA, BETA) distribution. Vectorized."
  134. BETA-QUANT
  135. "Args: (p alpha beta)\nReturns the P-th quantile of the Beta(ALPHA, BETA) distribution. Vectorized."
  136. BINOMIAL-CDF
  137. "Args (x n p)\nReturns value of the Binomial(N, P) distribution function at X. Vectorized."
  138. BINOMIAL-PMF
  139. "Args (k n p)\nReturns value of the Binomial(N, P) pmf function at integer K. Vectorized."
  140. BINOMIAL-QUANT
  141. "Args: (x n p)\nReturns x-th quantile (left continuous inverse) of Binomial(N, P) cdf.\nVectorized."
  142. BINOMIAL-RAND
  143. "Args: (k n p)\nReturns list of K draws from the Binomial(N, P) distribution. Vectorized."
  144. CAUCHY-CDF
  145. "Args: (x)\nReturns the value of the standard Cauchy distribution function at X.\nVectorized."
  146. CAUCHY-DENS
  147. "Args: (x)\nReturns the density at X of the standard Cauchy distribution. Vectorized."
  148. CAUCHY-QUANT
  149. "Args (p)\nReturns the P-th quantile(s) of the standard Cauchy distribution. Vectorized."
  150. CHISQ-CDF
  151. "Args: (x df)\nReturns the value of the Chi-Square(DF) distribution function at X. Vectorized."
  152. CHISQ-DENS
  153. "Args: (x alpha)\nReturns the density at X of the Chi-Square(DF) distribution. Vectorized."
  154. CHISQ-QUANT
  155. "Args: (p df)\nReturns the P-th quantile of the Chi-Square(DF) distribution. Vectorized."
  156. F-CDF
  157. "Args: (x ndf ddf)\nReturns the value of the F(NDF, DDF) distribution function at X. Vectorized."
  158. F-DENS
  159. "Args: (x ndf ddf)\nReturns the density at X of the F(NDF, DDF) distribution. Vectorized."
  160. F-QUANT
  161. "Args: (p ndf ddf)\nReturns the P-th quantile of the F(NDF, DDF) distribution. Vectorized."
  162. GAMMA-CDF
  163. "Args: (x alpha)\nReturns the value of the Gamma(alpha, 1) distribution function at X.\nVectorized."
  164. GAMMA-DENS
  165. "Args: (x alpha)\nReturns the density at X of the Gamma(ALPHA, 1) distribution. Vectorized."
  166. GAMMA-QUANT
  167. "Args: (p alpha)\nReturns the P-th quantile of the Gamma(ALPHA, 1) distribution. Vectorized."
  168. NORMAL-CDF
  169. "Args: (x)\nReturns the value of the standard normal distribution function at X.\nVectorized."
  170. BIVNORM-CDF
  171. "Args: (x y r)\nReturns the value of the standard bivariate normal distribution function \nwith correlation R at (X, Y). Vectorized."
  172. NORMAL-DENS
  173. "Args: (x)\nReturns the density at X of the standard normal distribution. Vectorized."
  174. NORMAL-QUANT
  175. "Args (p)\nReturns the P-th quantile of the standard normal distribution. Vectorized."
  176. ORDER
  177. "Args (x)\nReturns a sequence of the indices of elements in the sequence of numbers\nor strings X in order."
  178. POISSON-CDF
  179. "Args (x mu)\nReturns value of the Poisson(MU) distribution function at X. Vectorized."
  180. POISSON-PMF
  181. "Args (k mu)\nReturns value of the Poisson(MU) pmf function at integer K. Vectorized."
  182. POISSON-QUANT
  183. "Args: (x mu)\nReturns x-th quantile (left continuous inverse) of Poisson(MU) cdf.\nVectorized."
  184. POISSON-RAND
  185. "Args: (k mu)\nReturns list of K draws from the Poisson(MU) distribution. Vectorized."
  186. RANK
  187. "Args (x)\nReturns a sequence with the elements of the list or array of numbers or\nstrings X replaced by their ranks."
  188. SORT-DATA
  189. "Args: (sequence)\nReturns a sequence with the numbers or strings in the sequence X in order."
  190. T-CDF
  191. "Args: (x df)\nReturns the value of the T(DF) distribution function at X. Vectorized."
  192. T-DENS
  193. "Args: (x alpha)\nReturns the density at X of the T(DF) distribution. Vectorized."
  194. T-QUANT
  195. "Args: (p df)\nReturns the P-th quantile of the T(DF) distribution. Vectorized."
  196. UNIFORM-RAND
  197. "Args: (n)\nReturns a list of N uniform random variables from the range (0, 1).\nVectorized."
  198. NORMAL-RAND
  199. "Args: (n)
  200. Returns a list of N standard normal random numbers. Vectorized."
  201. CAUCHY-RAND
  202. "Args: (n)
  203. Returns a list of N standard Cauchy random numbers. Vectorized."
  204. T-RAND
  205. "Args: (n df)
  206. Returns a list of N T(DF) random variables. Vectorized."
  207. F-RAND
  208. "Args: (n ndf ddf)
  209. Returns a list of N F(NDF, DDF) random variables. Vectorized."
  210. GAMMA-RAND
  211. "Args: (n a)
  212. Returns a list of N Gamma(A, 1) random variables. Vectorized."
  213. CHISQ-RAND
  214. "Args: (n df)
  215. Returns a list of N Chi-Square(DF) random variables. Vectorized."
  216. BETA-RAND
  217. "Args: (n a b)
  218. Returns a list of N beta(A, B) random variables. Vectorized."
  219. HISTOGRAM
  220. "Args: (data &key (title "Histogram"))\nOpens a window with a histogram of DATA. TITLE is the window title. The number\nof bins used can be adjusted using the histogram menu. The histogram can be\nlinked to other plots with the link-views command. Returns a plot object."
  221. LINK-VIEWS
  222. "Args: (&rest plots)\nLinks the argument plots: any change in hiliting or visibility of points in\nthe current plot is propagated to the other plots."
  223. NAME-LIST
  224. "Args: (names &key (title "Name List"))\nNAMES is a number or a list of character strings. Opens a window with a list\nof the supplied character strings or entries numbered from 0 to NAMES - 1.\nThis display can be linked to plots with the link-views function. Returns a\nplot object."
  225. PLOT-FUNCTION
  226. "Args: (f xmin xmax &optional (num-points 50))\nPlots function F of one real variable over the range between xmin and xmax.\nThe function is evaluated at NUM-POINTS points."
  227. PLOT-LINES
  228. "Args: (x y &key (title "Line Plot") variable-labels type width color)\nOpens a window with a connected line plot of X vs Y, where X and Y are\ncompound number-data. VARIABLE-LABELS, if supplied, should be lists of\ncharacter strings. TITLE is the window title. The plot can be linked to\nother plots with the link-views command. Returns a plot object."
  229. PLOT-POINTS
  230. "Args: (x y &key (title "Scatter Plot") variable-labels point-labels symbol color)\nOpens a window with a scatter plot of X vs Y, where X and Y are compound\nnumber-data. VARIABLE-LABELS and POINT-LABELS, if supplied, should be lists of\ncharacter strings. TITLE is the window title. The plot can be linked to\nother plots with the link-views command. Returns a plot object."
  231. SCATTERPLOT-MATRIX
  232. "Args: (data &key (title "Spinning Plot") variable-labels point-labels\n                 (scale t))\nDATA is a list of two or more compound number-data objects of equal length.\nOpens a window with a brushable scatter plot matrix of the elements of DATA.\nVARIABLE-LABELS and POINT-LABELS, if supplied, should be lists of character strings.\nTITLE is the window title. If scale is NIL data are assumed to be between -1\nand 1.The plot can be linked to other plots with the link-views command.\nReturns a plot object."
  233. SPIN-PLOT
  234. "Args: (data &key (title "Spinning Plot") variable-labels point-labels\n                 (scale t))\nDATA is a list of three compound number-data objects of equal length. Opens\na window with a rotating plot of the three elements of DATA. VARIABLE-LABELS\nand POINT-LABELS, if supplied, should be lists of character strings. TITLE\nis the window title. If scale is NIL data are assumed to be between -1 and 1.\nThe plot can be linked to other plots with the link-views command. Returns\na plot object."
  235. (GRAPH-PROTO OBJECT :ADD-LINES)
  236. "Method args: (lines &key type (draw t))\nAdds lines to plot. LINES is a list of sequences, the coordinates of the line starts.\nTYPE is normal or dashed. If DRAW is true the new lines are added to the screen."
  237. (GRAPH-PROTO OBJECT :ADD-POINTS)
  238. "Method args: (points &key point-labels (draw t))\nAdds points to plot. POINTS is a list of sequences, POINT-LABELS a list of\nstrings. If DRAW is true the new points are added to the screen."
  239. (GRAPH-PROTO OBJECT :ADJUST-TO-DATA)
  240. "Method args: (&key (draw t))\nSets ranges to the actual range of variables in the original coordinate\nsystem. If DRAW is true sends :RESIZE and :REDRAW messages."
  241. (GRAPH-PROTO OBJECT :APPLY-TRANSFORMATION)
  242. "Method args: (a &key draw)\nApplies matrix A to current transformation. If draw is true the :REDRAW-CONTENT\nmessage is sent."
  243. (GRAPH-PROTO OBJECT :CLEAR)
  244. "\nMessage args: (&optional (draw t))\nClears the plot data. If DRAW is nil the plot is redrawn; otherwise its\ncurrent screen image remains unchanged."
  245. (GRAPH-PROTO OBJECT :CLEAR-LINES)
  246. "Method args: (&key (draw t))\nRemoves all lines from the plot. If DRAW is true the :REDRAW-CONTENT\nmessage is sent."
  247. (GRAPH-PROTO OBJECT :CLEAR-POINTS)
  248. "Method args: (&key (draw t))\nRemoves all points from the plot. If DRAW is true the :REDRAW-CONTENT\nmessage is sent."
  249. (GRAPH-PROTO OBJECT :ERASE-SELECTION)
  250. "Method args: ()\nSets selected points states to invisible and sends :ADJUST-POINT-SCREEN-STATES message."
  251. (GRAPH-PROTO OBJECT :IDLE-ON)
  252. "\nMethod args: (&optional on)\nSets or returns idling state. On means :do-idle method is sent each pass through\nthe event loop."
  253. (GRAPH-PROTO OBJECT :LINKED)
  254. "Method ars: (&optional on)\nSets or retrieves plot's linking state."
  255. (GRAPH-PROTO OBJECT :NUM-LINES)
  256. "Method args: ()\nReturns the number of line starts in the plot."
  257. (GRAPH-PROTO OBJECT :NUM-POINTS)
  258. "Method args: ()\nReturns the number of points in the plot."
  259. (GRAPH-PROTO OBJECT :NUM-VARIABLES)
  260. "Method args: ()\nReturns the number of variables in the plot."
  261. (GRAPH-PROTO OBJECT :POINT-HILITED)
  262. "Method args: (point &optional hilited)\nSets or returns highlighting status (true or NIL) of POINT. Sends \n:ADJUST-POINT-SCREEN-STATES message if states are set. Vectorized."
  263. (GRAPH-PROTO OBJECT :POINT-LABEL)
  264. "Method args: (point &optional label)\nSets or retrieves label of point POINT. Vectorized."
  265. (GRAPH-PROTO OBJECT :POINT-SELECTED)
  266. "Method args: (point &optional selected)\nSets or returns selection status (true or NIL) of POINT. Sends \n:ADJUST-POINT-SCREEN-STATES message if states are set. Vectorized."
  267. (GRAPH-PROTO OBJECT :POINT-SHOWING)
  268. "Method args: (point &optional selected)\nSets or returns visibility status (true or NIL) of POINT. Sends \n:ADJUST-POINT-SCREEN-STATES message if states are set. Vectorized."
  269. (GRAPH-PROTO OBJECT :POINT-SYMBOL)
  270. "Method args: (point &optional symbol)\nSets or retrieves symbol of point POINT. Vectorized."
  271. (GRAPH-PROTO OBJECT :RANGE)
  272. "Method args: (index &optional low high)\nSets or retrieves variable's original coordinate range. Vectorized."
  273. (GRAPH-PROTO OBJECT :ROTATE-2)
  274. "Method args: (var1 var2 angle &key (draw t))\nRotates int the plane of variables with indices VAR1 and VAR2 by ANGLE, in\nradians. sends the :REDRAW-CONTENT message if DRWA is true."
  275. (GRAPH-PROTO OBJECT :SELECTION)
  276. "Method args: ()\nReturn indices of current selection."
  277. (GRAPH-PROTO OBJECT :SHOW-ALL-POINTS)
  278. "Method args: ()\nSets all point states to normal and sends :ADJUST-POINT-SCREEN-STATES message "
  279. (GRAPH-PROTO OBJECT :SHOWING-LABELS)
  280. "Method args: (&optional showing)\nSets or retrieves current labeling state (true or NIL)."
  281. (GRAPH-PROTO OBJECT :TITLE)
  282. "Method args: (&optional string)\nSets or retrieves window title."
  283. (GRAPH-PROTO OBJECT :TRANSFORMATION)
  284. "Method args: (&optional a &key (draw t))\nSets or retrieves transformation. A should be a matrix or NIL. If draw is true\nthe :REDRAW-CONTENT message is sent."
  285. (GRAPH-PROTO OBJECT :VARIABLE-LABEL)
  286. "Method args: (var &optional label)\nSets or returns label for variable with index VAR. Vectorized."
  287. (HISTOGRAM-PROTO OBJECT :ADD-POINTS)
  288. "Method args: (points (draw t))\nAdds points to plot. POINTS is a sequence or a list of sequences. If DRAW is\ntrue the new points are added to the screen."
  289. (HISTOGRAM-PROTO OBJECT :NUM-BINS)
  290. "Method args: (&optional bins &key (draw t))\nSets or retrieves number of bins in the histogram. Sends :REDRAW-CONTENT message\nif DRAW is true."
  291. (NAME-LIST-PROTO OBJECT :ADD-POINTS)
  292. "Method args: (points &key point-labels (draw t))\nAdds points to plot. POINTS is a number or a list of sequences, POINT-LABELS a list of\nstrings. If DRAW is true the new points are added to the screen."
  293. (SCATTERPLOT-PROTO OBJECT :ADD-LINES)
  294. "Method args: (lines &key type (draw t))
  295. or:          (x y  &key point-labels (draw t))
  296. Adds lines to plot. LINES is a list of sequences, the 
  297. coordinates of the line  starts. TYPE is normal or dashed. If
  298. DRAW is true the new lines are added to the screen. For a 2D
  299. plot POINTS can be replaced by two sequences X and Y."
  300. (SCATTERPLOT-PROTO OBJECT :ADD-POINTS)
  301. "Method args: (points &key point-labels (draw t))
  302. or:          (x y  &key point-labels (draw t))
  303. Adds points to plot. POINTS is a list of sequences, 
  304. POINT-LABELS a list of strings. If DRAW is true the new points
  305. are added to the screen. For a 2D plot POINTS can be replaced
  306. by two sequences X and Y."
  307. (SPIN-PROTO OBJECT :ANGLE)
  308. "Method args: (&optional angle)\nSets or retrieves current rotation angle, in radians."
  309. (SPIN-PROTO OBJECT :DO-IDLE)
  310. "Method args: ()\nSends :ROTATE message."
  311. (SPIN-PROTO OBJECT :ROTATE)
  312. "Method args: ()\nRotates once in the current plane by the current angle."
  313. (SPIN-PROTO OBJECT :SHOWING-AXES)
  314. "Method args: (&optional cuing)\nSets or retrieves cuing status (true or NIL)."
  315. %*
  316. "Args: (a b)\nReturns the matrix product of matrices a and b. If a is a vector it is treated\nas a row vector; if b is a vector it is treated as a column vector."
  317. BIND-COLUMNS
  318. "Args (&rest args)\nThe ARGS can be matrices, vectors, or lists. Arguments are bound into a matrix\nalong their columns.\nExample: (bind-columns #2a((1 2)(3 4)) #(5 6)) returns #2a((1 2 5)(3 4 6))"
  319. BIND-ROWS
  320. "Args (&rest args)\nThe ARGS can be matrices, vectors, or lists. Arguments are bound into a matrix\nalong their rows.\nExample: (bind-rows #2a((1 2)(3 4)) #(5 6)) returns #2a((1 2)(3 4)(5 6))"
  321. CHOL-DECOMP
  322. "Args: (a)\nModified Cholesky decomposition. A should be a square, symmetric matrix.\nComputes lower triangular matrix L such that L L^T = A + D where D is a diagonal\nmatrix. If A is strictly positive definite D will be zero. Otherwise D is as\nsmall as possible to make A + D numerically strictly positive definite. Returns\na list (L (max D))."
  323. COLUMN-LIST
  324. "Args: (m)\nReturns a list of the columns of M as vectors"
  325. COPY-ARRAY
  326. "Args: (array)\nReturns a copy of ARRAY with elements eq to the elements of ARRAY."
  327. COPY-LIST
  328. "Args: (list)\nReturns a new copy of LIST."
  329. COPY-VECTOR
  330. "Args: (VECTOR)\nReturns a copy of VECTOR with elements eq to the elements of VECTOR"
  331. COUNT-ELEMENTS
  332. "Args: (number &rest more-numbers)\nReturns the number of its arguments. Vector reducing"
  333. CROSS-PRODUCT
  334. "Args: (x)\nIf X is a matrix returns (%* (TRANSPOSE X) X). If X is a vector returns\n(INNER-PRODUCT X X)."
  335. DETERMINANT
  336. "Args: (m)\nReturns the determinant of the square matrix M."
  337. DIAGONAL
  338. "Args: (x)\nIf X is a matrix, returns the diagonal of X. If X is a sequence, returns a\ndiagonal matrix of rank (length X) with diagonal elements eq to the elements\nof X."
  339. EIGEN
  340. "Args: (a)\nReturns list of list of eigenvalues and list of eigenvectors of square,\nsymmetric matrix A. Third element of result is NIL if algorithm converges.\nIf the algorithm does not converge, the third element is an integer I.\nIn this case the eigenvalues 0, ..., I are not reliable."
  341. IDENTITY-MATRIX
  342. "Args: (n)\nReturns the identity matrix of rank N."
  343. INNER-PRODUCT
  344. "Args: (x y)\nReturns inner product of sequences X and Y."
  345. INVERSE
  346. "Args: (m)\nReturns the inverse of the the square matrix M; signals an error if M is ill\nconditioned or singular"
  347. LU-DECOMP
  348. "Args: (a)\nA is a square matrix of numbers (real or complex). Computes the LU\ndecomposition of A and returns a list of the form (LU IV D FLAG), where\nLU is a matrix with the L part in the lower triangle, the U part in the \nupper triangle (the diagonal entries of L are taken to be 1), IV is a vector\ndescribing the row permutation used, D is 1 if the number of permutations\nis odd, -1 if even, and FLAG is T if A is numerically singular, NIL otherwise.\nUsed bu LU-SOLVE."
  349. LU-SOLVE
  350. "Args: (lu b)\nLU is the result of (LU-DECOMP A) for a square matrix A, B is a sequence.\nReturns the solution to the equation Ax = B. Signals an error if A is singular."
  351. MAKE-SWEEP-MATRIX
  352. "Args: (x y &optional weights)\nX is a matrix, Y and WEIGHTS are sequences. Returns the sweep matrix for the\n(possibly weighted) regression of Y on X."
  353. MAP-ELEMENTS
  354. "Args: (function data &rest more-data)\nFUNCTION must take as many arguments as there are DATA arguments supplied.\nDATA arguments must either all be sequences or all be arrays of the same\nshape. The result is of the same type and shape as the first DATA argument,\nwith elements the result of applying FUNCTION elementwise to the DATA\narguments"
  355. MATMULT
  356. "Args: (a b)\nReturns the matrix product of matrices a and b. If a is a vector it is treated\nas a row vector; if b is a vector it is treated as a column vector."
  357. MATRIXP
  358. "Args: (m)\nReturns T if M is a matrix, NIL otherwise."
  359. MEAN
  360. "Args: (x)
  361. Returns the mean of the elements x. Vector reducing."
  362. OUTER-PRODUCT
  363. "Args: (x y &optional (fcn #'*))\nReturns the generalized outer product of x and y, using fcn. Tat is, the result\nis a matrix of dimension ((length x) (length y)) and the (i j) element of the\nresult is computed as (apply fcn (aref x i) (aref y j))."
  364. PERMUTE-ARRAY
  365. "Args: (a p)\nReturns a copy of the array A permuted according to the permutation P."
  366. QR-DECOMP
  367. "Args: (a &optional pivot)
  368. A is a matrix of real numbers with at least as many rows as columns. Computes
  369. the QR factorization of A and returns the result in a list of the form (Q R).
  370. If PIVOT is true the columns of X are first permuted to place insure the
  371. absolute values of the diagonal elements of R are nonincreasing. In this case
  372. the result includes a third element, a list of the indices of the columns in
  373. the order in which they were used."
  374. RCONDEST
  375. "Args: (a)\nReturns an estimate of the reciprocal of the L1 condition number of an upper\ntriangular matrix a."
  376. ROW-LIST
  377. "Args: (m)\nReturns a list of the rows of M as vectors"
  378. SOLVE
  379. "Args: (a b)\nSolves A x = B using LU decomposition and backsolving. B can be a sequence\nor a matrix."
  380. SV-DECOMP
  381. "Args: (a)\nA is a matrix of real numbers with at least as many rows as columns.\nComputes the singular value decomposition of A and returns a list of the form\n(U W V FLAG) where U and V are matrices whose columns are the left and right\nsingular vectors of A and W is the sequence of singular values of A. FLAG is T\nif the algorithm converged, NIL otherwise."
  382. SWEEP-OPERATOR
  383. "Args: (a indices &optional tolerances)\nA is a matrix, INDICES a sequence of the column indices to be swept. Returns\na list of the swept result and the list of the columns actually swept. (See\nMULTREG documentation.) If supplied, TOLERANCES should be a list of real\nnumbers the same length as INDICES. An index will only be swept if its pivot\nelement is larger than the corresponding element of TOLERANCES."
  384. TRANSPOSE
  385. "Args: (m)\nReturns the transpose of the matrix M."
  386. VECTORP
  387. "Args: (m)\nReturns T if M is a vector, NIL otherwise."
  388. LOAD
  389. "Args: (filename &key (verbose t) (print nil))\nLoads the file named by FILENAME into XLISP. Returns T if load succeeds,\nNIL if file does not exist."
  390. ROOM
  391. "Args: ()\nShows memory allocation statistics. Returns nil."
  392. AND
  393. "Syntax: (and {form}*)\nEvaluates FORMs in order from left to right.  If any FORM evaluates to NIL,\nreturns immediately with the value NIL.  Else, returns the value of the\nlast FORM."
  394. APPEND
  395. "Args: (&rest lists)\nConstructs a new list by concatenating its arguments."
  396. APPLY
  397. "Args: (function &rest args)\nConses all arguments but the last onto the last and applies FUNCTION to \nthe resulting argument list. Last argument must be a list."
  398. APROPOS
  399. "Args: (string)\nPrints symbols whose print-names contain STRING as substring.\nIf STRING is a symbol its print name is used."
  400. ASSOC
  401. "Args: (item alist &key (test #'eql) test-not)\nReturns the first pair in ALIST whose car is equal (in the sense of TEST) to\nITEM."
  402. ATOM
  403. "Args: (x)\nReturns T if X is not a cons; NIL otherwise."
  404. CAR
  405. "Args: (list)\nReturns the car of LIST.  Returns NIL if LIST is NIL."
  406. CASE
  407. "Syntax: (case keyform {({key | ({key}*)} {form}*)}*)\nEvaluates KEYFORM and tries to find the KEY that is EQL to the value of\nKEYFORM.  If one is found, then evaluates FORMs that follow the KEY and\nreturns the value of the last FORM.  If not, simply returns NIL."
  408. CDR
  409. "Args: (list)\nReturns the cdr of LIST.  Returns NIL if LIST is NIL."
  410. CLOSE
  411. "Args: (stream)\nClose file stream STREAM."
  412. COERCE
  413. "Args: (x type)\nCoerces X to an object of the type TYPE."
  414. COND
  415. "Syntax: (cond {(test {form}*)}*)\nEvaluates each TEST in order until one evaluates to a non-NIL value.  Then\nevaluates the associated FORMs in order and returns the value of the last\nFORM.  If no forms follow the TEST, then returns the value of the TEST.\nReturns NIL, if all TESTs evaluate to NIL."
  416. CONS
  417. "Args: (x y)\nReturns a new cons (list node) whose car and cdr are X and Y, respectively."
  418. CONSP
  419. "Args: (x)\nReturns T if X is a cons; NIL otherwise."
  420. DEFUN
  421. "Syntax: (defun name lambda-list [doc] {form}*)\nDefines a function as the global definition of the symbol NAME. The\ncomplete syntax of a lambda-list is:\n\t({var}*\n\t [&optional {var}*]\n\t [&rest var]\n\t [&aux {var}*])\nThe doc-string DOC, if supplied, is saved as a FUNCTION doc and can be\nretrieved by (documentation 'NAME 'function)."
  422. DO
  423. "Syntax: (do ({(var [init [step]])}*) (endtest {result}*) {tag | statement}*)\nCreates a NIL block, binds each VAR to the value of the corresponding INIT,\nand then executes STATEMENTs repeatedly until ENDTEST is satisfied.  After\neach iteration, assigns to each VAR the value of the corresponding STEP.  When\nENDTEST is satisfied, evaluates RESULTs as a PROGN and returns the value of\nthe last RESULT (or NIL if no RESULTs are supplied).  Performs variable\nbindings and assignments all at once, just like LET does."
  424. DO*
  425. "Syntax: (do* ({(var [init [step]])}*) (endtest {result}*) {tag | statement}*)\nJust like DO, but performs variable bindings and assignments in serial, just\nlike LET* and SETQ do."
  426. DOLIST
  427. "Syntax: (dolist (var listform [result]) {tag | statement}*)\nExecutes STATEMENTs, with VAR bound to each member of the list value of\nLISTFORM.  Then returns the value of RESULT (which defaults to NIL)."
  428. DOTIMES
  429. "Syntax: (dotimes (var countform [result]) {tag | statement}*)\nExecutes STATEMENTs, with VAR bound to each number between 0 (inclusive) and\nthe value of COUNTFORM (exclusive).  Then returns the value of RESULT\n(which defaults to NIL)."
  430. ELT
  431. "Args: (a &rest indices)\nReturns element I of sequence A. ELT can be used in setf."
  432. EQ
  433. "Args: (x y)\nReturns T if X and Y are the same identical object; NIL otherwise."
  434. EQL
  435. "Args: (x y)\nReturns T if X and Y are EQ, or if they are numbers of the same type with\nthe same value, or if they are identical strings.  Returns NIL otherwise."
  436. EQUAL
  437. "Args: (x y)\nReturns T if X and Y are EQL or if they are of the same type and corresponding\ncomponents are EQUAL.  Returns NIL otherwise. Arrays must be EQ to be EQUAL."
  438. EQUALP
  439. "Args: (x y)\nReturns T if (equal x y), or x, y are numbers and (= x y), or\nx and y are strings and (string-equal x y)."
  440. FORMAT
  441. "Args: (destination control &rest args)\nVery basic implementation of Common Lisp format function. Only A, S, D, F, E,\nG, %, and ~ directives are supported. D, % and ~ can take one argument, R, E\nand G can take two."
  442. FUNCALL
  443. "Args: (function &rest arguments)\nApplies FUNCTION to the ARGUMENTs"
  444. IF
  445. "Syntax: (if test then [else])\nIf TEST evaluates to non-NIL, then evaluates THEN and returns the result.\nIf not, evaluates ELSE (which defaults to NIL) and returns the result."
  446. LAST
  447. "Args: (list)\nReturns the last cons in LIST"
  448. LENGTH
  449. "Args: (sequence)\nReturns the length of SEQUENCE."
  450. LET
  451. "Syntax: (let ({var | (var [value])}*) {form}*)\nInitializes VARs, binding them to the values of VALUEs (which defaults to NIL)\nall at once, then evaluates FORMs as a PROGN."
  452. LET*
  453. "Syntax: (let* ({var | (var [value])}*) {form}*)\nInitializes VARs, binding them to the values of VALUEs (which defaults to NIL)\nfrom left to right, then evaluates FORMs as a PROGN."
  454. LISTP
  455. "Args: (x)\nReturns T if X is either a cons or NIL; NIL otherwise."
  456. MAP
  457. "Args: (result-type function sequence &rest more-sequences)\nFUNCTION must take as many arguments as there are sequences provided. RESULT-TYPE\nmust be the either the symbol VECTOR or the symbol LIST. The result is a \nsequence of the specified type such that the i-th element of the result is the\nresult of applying FUNCTION to the i-th elements of the SEQUENCEs."
  458. MAPCAR
  459. "Args: (fun list &rest more-lists)\nApplies FUN to successive cars of LISTs and returns the results as a list."
  460. MEMBER
  461. "Args: (item list &key (test #'eql) test-not)\nReturns the tail of LIST beginning with the first ITEM."
  462. NTH
  463. "Args: (n list)\nReturns the N-th element of LIST, where the car of LIST is the zero-th\nelement."
  464. NTHCDR
  465. "Args: (n list)\nReturns the result of performing the CDR operation N times on LIST."
  466. NULL
  467. "Args: (x)\nReturns T if X is NIL; NIL otherwise."
  468. NUMBERP
  469. "Args: (x)\nReturns T if X is any kind of number; NIL otherwise."
  470. OBJECTP
  471. "Args: (x)\nReturns T if X is an object, NIL otherwise."
  472. OR
  473. "Syntax: (or {form}*)\nEvaluates FORMs in order from left to right.  If any FORM evaluates to\nnon-NIL, quits and returns that value.  If the last FORM is reached,\nreturns whatever value it returns."
  474. PRIN1
  475. "Args: (object &optional (stream *standard-output*))\nPrints OBJECT in the most readable representation.  Returns OBJECT."
  476. PRINC
  477. "Args: (object &optional (stream *standard-output*))\nPrints OBJECT without escape characters.  Returns OBJECT."
  478. PRINT
  479. "Args: (object &optional (stream *standard-output*))\nOutputs a newline character, and then prints OBJECT in the most readable\nrepresentation.  Returns OBJECT."
  480. REMOVE
  481. "Args: (item list &key (test #'eql) test-not)\nReturns a copy of LIST with ITEM removed."
  482. RETURN
  483. "Syntax: (return [result])\nReturns from the lexically surrounding PROG construct.  The value of RESULT,\nwhich defaults to NIL, is returned as the value of the PROG construct."
  484. REVERSE
  485. "Args: (list)\nReturns a new list containing the same elements as LIST but in\nreverse order."
  486. SETF
  487. "Syntax: (setf {place newvalue}*)\nReplaces the value in PLACE with the value of NEWVALUE, from left to right.\nReturns the value of the last NEWVALUE.  Each PLACE may be any one of the\nfollowing:\n  * A symbol that names a variable.\n  * A function call form whose first element is the name of the following\n    functions:\n\tnth\n\taref subarray sublist select elt\n\tget\n\tsymbol-value\n\tsymbol-plist\n\tdocumentation\n\tslot-value\n\tc?r\tc??r\tc???r\tc????r\n    where '?' stands for either 'a' or 'd'."
  488. SETQ
  489. "Syntax: (setq {var form}*)\nVARs are not evaluated and must be symbols.  Assigns the value of the first\nFORM to the first VAR, then assigns the value of the second FORM to the second\nVAR, and so on.  Returns the last value assigned."
  490. STRING
  491. "\nArgs: (sym)\nReturns print-name of SYM if SYM is a symbol, or SYM if SYM is a string."
  492. STRINGP
  493. "Args: (x)\nReturns T if X is a string; NIL otherwise."
  494. SYMBOLP
  495. "Args: (x)\nReturns T if X is a symbol; NIL otherwise."
  496. TERPRI
  497. "Args: (&optional (stream *standard-output*))\nOutputs a newline character."
  498. UNLESS
  499. "Syntax: (unless test {form}*)\nIf TEST evaluates to NIL evaluates FORMs as a PROGN.  If not, returns NIL."
  500. KIND-OF-P
  501. "Args: (x y)
  502. Returns T is X and Y are objects and X inherits from Y, NIL otherwise."
  503. SLOT-VALUE
  504. "Args: (slot &optional value)
  505. Must be used in a method. Returns the value of current objects slot named SLOT.
  506. If Value is supplied SLOT is set to VALUE. Can be used in setf."
  507. MAKE-OBJECT
  508. "Args: (&rest parents)
  509. Returns a new object with parents PARENTS. If PARENTS is NIL (list *OBJECT*)
  510. is used."
  511. SEND
  512. "Args: (object selector &rest args)
  513. Applies first method for SELECTOR found in OBJECT's precedence list to
  514. OBJECT and ARGS."
  515. SEND-SUPER
  516. "Args: (selector &rest args)
  517. Apply inherited method. Must be used within a method. Specifically, Applies 
  518. first method for SELECTOR found in the cdr of the precedence list of the owner
  519. of the current method to the current object and args."
  520. CALL-METHOD
  521. "Args (object selector &rest args)
  522. Funcalls method for SELECTOR found in OBJECT to SELF. Can only be used in a method."
  523. CALL-NEXT-METHOD
  524. "Args (&rest args)
  525. Funcalls next method for current selector and precedence list. Can only be used in a method."
  526. DEFMETH
  527. "Syntax: (defmeth object name lambda-list [doc] {form}*)
  528. OBJECT must evaluate to an existing object. Installs a method for NAME in
  529. the value of OBJECT and installs DOC in OBJECTS's documentation."
  530. DEFPROTO
  531. "Syntax (defproto name &optional ivars cvars (parent *object*) doc)
  532. Makes a new object prototype with instance variables IVARS, 'class'
  533. variables CVARS and parents PARENT. PARENT can be a single object or
  534. a list of objects. IVARS and CVARS must be lists."
  535.